[DX-629] Add Chat React API references by m-hulbert · Pull Request #3272 · ably/docs

m-hulbert · 2026-03-12T19:25:58Z

Description

This PR adds an API reference for Chat in React using the new NestedTable and MethodSignature components. It should have parity with the TypeDoc references.

There is 1 commit per file, however I haven't yet updated the references in the conceptual content to point to these references yet to keep this PR smaller for review feedback. I will add that as a final commit once we are happy with this content.

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

coderabbitai · 2026-03-12T19:26:34Z

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 6b4e0167-50a2-4a84-a4ec-f71d7dba635f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch dx-629-chat-react-api-refs

📝 Coding Plan

Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

You can validate your CodeRabbit configuration file in your editor.

If your editor has YAML language server, you can enable auto-completion and validation by adding # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json at the top of your CodeRabbit configuration file.

splindsay-92

Just a few things so far, but mostly looks good!

src/pages/docs/chat/api/react/providers.mdx

splindsay-92 · 2026-03-13T10:18:01Z

src/pages/docs/chat/api/react/providers.mdx

+| --- | --- | --- | --- |
+| name | Required | The name of the room. | String |
+| options | Optional | Options to use when creating the room. Must be memoized to prevent unnecessary room recreations. Room options are immutable after creation; differing options for the same room name cause errors. | <Table id='RoomOptions'/> |
+| children | Optional | Child components that will have access to the room context. | ReactNode or ReactNode[] |


Isn't ReactNode nullable? As in do you think we need to explicitly state it as a type?

src/pages/docs/chat/api/react/providers.mdx

splindsay-92 · 2026-03-14T09:22:01Z

src/pages/docs/chat/api/react/providers.mdx

+| code | Ably-specific error code. | Number |
+| statusCode | HTTP status code corresponding to this error, where applicable. | Number |
+| message | Additional information about the error. | String |
+| cause | The underlying cause of the error, where applicable. | String, ErrorInfo, or Error |


This is now incorrect, ably-js lists this as an errorInfo only I believe, chat is likely using the same type now. I'll double check and update the codebase if I've not already done so :)

Ah thanks - updated in 797ae27 and also did a separate commit to fix JS: a8b18c3

splindsay-92 · 2026-03-14T09:34:05Z

src/pages/docs/chat/api/react/use-messages.mdx

+
+</Table>
+
+<Table id='MessageReactionSummaryEvent' hidden>


I think the 'clipped' flag is missing from these summary event types.

Is that missing from TypeDoc?

src/pages/docs/chat/api/react/use-messages.mdx

m-hulbert and others added 12 commits March 12, 2026 19:24

Add Providers API reference for Chat React SDK

b322c57

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add useChatClient hook API reference

3b201ad

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add useChatConnection hook API reference

dec57f9

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add useRoom hook API reference

087105a

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add useMessages hook API reference

73cfb2d

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add usePresence hook API reference

b0e001b

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add usePresenceListener hook API reference

0bfa6f2

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add useOccupancy hook API reference

872091e

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add useTyping hook API reference

7bce2cb

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add useRoomReactions hook API reference

b748739

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Add React hooks section to Chat navigation

e9feb4e

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Update Chat API index to link to React hook references

15ddaf8

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

m-hulbert self-assigned this Mar 12, 2026

m-hulbert added the review-app Create a Heroku review app label Mar 12, 2026

ably-ci temporarily deployed to ably-docs-dx-629-chat-r-bl9cry March 12, 2026 19:26 Inactive

m-hulbert requested a review from splindsay-92 March 13, 2026 08:50

splindsay-92 reviewed Mar 14, 2026

View reviewed changes

m-hulbert added 2 commits March 17, 2026 18:28

fixup! Add Providers API reference for Chat React SDK

797ae27

fixup! Add useMessages hook API reference

ff16353

m-hulbert temporarily deployed to ably-docs-dx-629-chat-r-bl9cry March 17, 2026 18:29 Inactive

fix: update ErrorInfo.cause to type ErrorInfo in chat JS refs

a8b18c3

m-hulbert deployed to ably-docs-dx-629-chat-r-bl9cry March 17, 2026 18:30 View deployment

m-hulbert requested a review from splindsay-92 March 17, 2026 18:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX-629] Add Chat React API references#3272

[DX-629] Add Chat React API references#3272
m-hulbert wants to merge 15 commits intomainfrom
dx-629-chat-react-api-refs

m-hulbert commented Mar 12, 2026

Uh oh!

coderabbitai bot commented Mar 12, 2026 •

edited

Loading

Review skipped

Uh oh!

splindsay-92 left a comment

Uh oh!

Uh oh!

splindsay-92 Mar 13, 2026

Uh oh!

m-hulbert Mar 17, 2026

Uh oh!

Uh oh!

splindsay-92 Mar 14, 2026

Uh oh!

m-hulbert Mar 17, 2026

Uh oh!

splindsay-92 Mar 14, 2026

Uh oh!

m-hulbert Mar 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

	\| children \| Optional \| Child components that will have access to the room context. \| ReactNode or ReactNode[] \|
	\| children \| Optional \| Child components that will have access to the room context. \| ReactNode, ReactNode[] or null \|

Conversation

m-hulbert commented Mar 12, 2026

Description

Checklist

Uh oh!

coderabbitai bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

splindsay-92 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

splindsay-92 Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

m-hulbert Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

splindsay-92 Mar 14, 2026

Choose a reason for hiding this comment

Uh oh!

m-hulbert Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

splindsay-92 Mar 14, 2026

Choose a reason for hiding this comment

Uh oh!

m-hulbert Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

coderabbitai bot commented Mar 12, 2026 •

edited

Loading